[MAINT] Fixup `github_repository_file` by deiga · Pull Request #3175 · integrations/terraform-provider-github

deiga · 2026-02-09T17:05:57Z

Resolves #3161

Before the change?

There was no test for importing github_repository_file
Import format: repo/file or repo/file:branch; default branch was imported without an explicit branch segment.
Branch field: branch was optional and not Computed; state could omit it for default-branch resources.
State: No migration for old ID formats; repository_id was not part of the resource’s state.
autocreate_branch: Used in Read, Update, and Delete; no deprecation notice.

After the change?

We have tests for importing github_repository_file
Adds Computed: true to branch
Adds computed repository_id field and enables repo renaming without resource recreation
Computes branch on create or import if not specified
Changes ID schema from <repo>/<file> to <repo>:<file>:<branch> to enable safer usage of multiple files from same repo but different branches
Adds State migration for computing branch, repository_id and new ID format
Import format: repo:file:branch (colon-separated); default branch uses repo:file: (trailing colon). Matches the internal ID format.
autocreate_branch: Deprecated and no longer used in Read, Update, or Delete.

Pull request checklist

Schema migrations have been created if needed (example)
Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

Yes
No

github-actions · 2026-02-09T17:06:08Z

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

deiga · 2026-02-09T17:18:06Z

Signed-off-by: Timo Sand <[email protected]>

stevehipwell

I missed the fact that the branch is optional, I think this should be required in the next major version. As it's optional then the import ID should allow it to be not set.

stevehipwell · 2026-02-09T17:28:35Z

So what I'm saying is the following changes are needed to fix this resource.

Add Computed: true to branch
Compute branch on create if not specified
Support importing with ID missing branch (compute on import only if missing)
Add migration to fix defect with ID not containing branch and missing branch computed value

Signed-off-by: Timo Sand <[email protected]>

stevehipwell

We can simplify the logic by always requiring a 2 part ID, with the second part blank for the default ID; e.g. my-repo/my-file.txt:.

Longer term the ID should be in the form <repo>:<file>:<branch>, but that's a problem for another day.

Always use 2 part ID for import. Use buildID for resource ID

deiga · 2026-02-10T09:33:01Z

@stevehipwell Done. But I wonder if I should just refactor the import ID now as well? Sure, it's technically a breaking change, but imports are "one-off" usually

stevehipwell · 2026-02-10T12:17:06Z

@stevehipwell Done. But I wonder if I should just refactor the import ID now as well? Sure, it's technically a breaking change, but imports are "one-off" usually

@deiga I think this makes sense. @nickfloyd thoughts?

We should also add repository_id to the schema as part of the migration, add the diffRepository, and remove ForceNew from repository; this will stop files being destroyed if the repo name changes.

Use 3 part ID for import as well

Signed-off-by: Timo Sand <[email protected]>

This required changing all tests to need a mock of the GH API Signed-off-by: Timo Sand <[email protected]>

deiga · 2026-02-10T19:34:02Z

@stevehipwell Addressed your comments. And re-introduced the API Mock pattern here, since it's the only way to verify the migration.

Would you still prefer that we discuss before we can add this pattern?

stevehipwell · 2026-02-10T20:16:18Z

Would you still prefer that we discuss before we can add this pattern?

Yes, I don't think this is the time to add this; but I think it's something we need to explore further.

stevehipwell

I've added inline comments, but you'll also need to add an ID set to update as the ID needs to be updated if the repo name has changed.

deiga · 2026-02-10T20:55:03Z

@stevehipwell

you'll also need to add an ID set to update as the ID needs to be updated if the repo name has changed.

Doesn't ForceNew run Create, so that shouldn't be needed in Update?

stevehipwell · 2026-02-10T20:58:41Z

Doesn't ForceNew run Create, so that shouldn't be needed in Update?

The diff function supports changing the repo name without forcing new, so we have to set the ID in update.

deiga · 2026-02-10T21:15:39Z

@stevehipwell If the repository_id changes, then we set ForceNew on repository. Which triggers Create instead if Update, or do I have that mixed up?
Is there any case where repository_id would change and need to be set in Update?

Signed-off-by: Timo Sand <[email protected]>

stevehipwell · 2026-02-10T22:17:17Z

@stevehipwell If the repository_id changes, then we set ForceNew on repository. Which triggers Create instead if Update, or do I have that mixed up?
Is there any case where repository_id would change and need to be set in Update?

The resource ID uses repo name so we need to call d.SetId(), not update the repository_id as that is static.

deiga · 2026-02-11T03:40:07Z

@stevehipwell Doh! 🤦
Sorry, I kept misunderstanding your point

Signed-off-by: Timo Sand <[email protected]>

…ete` Signed-off-by: Timo Sand <[email protected]>

Signed-off-by: Timo Sand <[email protected]>

deiga · 2026-02-11T04:00:53Z

@stevehipwell I went and deprecated the whole autocreate_branch stuff, let me know if I went too far :D

And, could you update the title of this PR to something like "resource_github_repository_file: fix import format and add state migrations"

stevehipwell

This is looking good @deiga, just a couple of things to look at.

Signed-off-by: Timo Sand <[email protected]>

stevehipwell

LGTM

* Improve docs of importing `github_repository_file` Signed-off-by: Timo Sand <[email protected]> * Add missing test for import Signed-off-by: Timo Sand <[email protected]> * Ensure we only set `branch` on import if it's not the default branch Signed-off-by: Timo Sand <[email protected]> * Update `branch` to `Computed` field Signed-off-by: Timo Sand <[email protected]> * Add state migration for missing branch field Signed-off-by: Timo Sand <[email protected]> * Add ID migration in the same bunch Signed-off-by: Timo Sand <[email protected]> * Fix ID parsing Signed-off-by: Timo Sand <[email protected]> * fixup! Fix ID parsing Always use 2 part ID for import. Use buildID for resource ID * fixup! fixup! Fix ID parsing Use 3 part ID for import as well * fixup! fixup! fixup! Add computed `repository_id` field to resource Signed-off-by: Timo Sand <[email protected]> * fixup! fixup! fixup! fixup! Add migration of the `repository_id` field. This required changing all tests to need a mock of the GH API Signed-off-by: Timo Sand <[email protected]> * Comment out test in evaluation Signed-off-by: Timo Sand <[email protected]> * fixup! Address review comments Signed-off-by: Timo Sand <[email protected]> * fixup! Address review comments Signed-off-by: Timo Sand <[email protected]> * fixup! Remove usage of autocreate_branch in `Read`, `Update` and `Delete` Signed-off-by: Timo Sand <[email protected]> * Mark `autocreate_branch` as deprecated Signed-off-by: Timo Sand <[email protected]> * fixup! Address review comments Signed-off-by: Timo Sand <[email protected]> * fixup! Change to use `UpdateFile` in `Update` Signed-off-by: Timo Sand <[email protected]> * fixup! Update docs with missing fields Signed-off-by: Timo Sand <[email protected]> --------- Signed-off-by: Timo Sand <[email protected]>

deiga requested review from nickfloyd and stevehipwell and removed request for nickfloyd February 9, 2026 17:16

deiga marked this pull request as ready for review February 9, 2026 17:16

deiga added 3 commits February 9, 2026 19:18

Improve docs of importing github_repository_file

c634707

Signed-off-by: Timo Sand <[email protected]>

Add missing test for import

3965ecb

Signed-off-by: Timo Sand <[email protected]>

Ensure we only set branch on import if it's not the default branch

aef6dcf

Signed-off-by: Timo Sand <[email protected]>

deiga force-pushed the update-repository_file-import-docs branch from 1337fdb to aef6dcf Compare February 9, 2026 17:18

nickfloyd previously approved these changes Feb 9, 2026

View reviewed changes

stevehipwell requested changes Feb 9, 2026

View reviewed changes

Comment thread github/resource_github_repository_file.go

nickfloyd self-requested a review February 9, 2026 17:22

deiga added 3 commits February 9, 2026 20:46

Update branch to Computed field

6b2938f

Signed-off-by: Timo Sand <[email protected]>

Add state migration for missing branch field

76e4f34

Signed-off-by: Timo Sand <[email protected]>

Add ID migration in the same bunch

db068df

Signed-off-by: Timo Sand <[email protected]>

deiga dismissed nickfloyd’s stale review via db068df February 9, 2026 20:11

deiga requested a review from stevehipwell February 9, 2026 20:12

Fix ID parsing

3c2e590

Signed-off-by: Timo Sand <[email protected]>

stevehipwell requested changes Feb 9, 2026

View reviewed changes

Comment thread github/resource_github_repository_file.go Outdated

Comment thread github/resource_github_repository_file.go Outdated

fixup! Fix ID parsing

e75070b

Always use 2 part ID for import. Use buildID for resource ID

deiga requested a review from stevehipwell February 10, 2026 09:32

deiga added 3 commits February 10, 2026 20:53

fixup! fixup! Fix ID parsing

581f684

Use 3 part ID for import as well

fixup! fixup! fixup! Add computed repository_id field to resource

9b9f8b8

Signed-off-by: Timo Sand <[email protected]>

fixup! fixup! fixup! fixup! Add migration of the repository_id field.

46162f6

This required changing all tests to need a mock of the GH API Signed-off-by: Timo Sand <[email protected]>

stevehipwell requested changes Feb 10, 2026

View reviewed changes

fixup! Address review comments

b07ed84

Signed-off-by: Timo Sand <[email protected]>

deiga requested a review from stevehipwell February 10, 2026 21:38

stevehipwell requested changes Feb 10, 2026

View reviewed changes

deiga added 3 commits February 11, 2026 05:45

fixup! Address review comments

5e43cb5

Signed-off-by: Timo Sand <[email protected]>

fixup! Remove usage of autocreate_branch in Read, Update and `Del…

0d8ebfe

…ete` Signed-off-by: Timo Sand <[email protected]>

Mark autocreate_branch as deprecated

d2f19df

Signed-off-by: Timo Sand <[email protected]>

deiga requested a review from stevehipwell February 11, 2026 04:00

stevehipwell reviewed Feb 11, 2026

View reviewed changes

Comment thread github/resource_github_repository_file.go Outdated

Comment thread github/resource_github_repository_file.go

Comment thread github/resource_github_repository_file.go Outdated

Comment thread github/resource_github_repository_file.go Outdated

deiga added 2 commits February 11, 2026 15:48

fixup! Address review comments

aa0a114

Signed-off-by: Timo Sand <[email protected]>

fixup! Change to use UpdateFile in Update

1fe800a

Signed-off-by: Timo Sand <[email protected]>

deiga requested a review from stevehipwell February 11, 2026 14:24

stevehipwell reviewed Feb 11, 2026

View reviewed changes

Comment thread github/resource_github_repository_file.go

stevehipwell reviewed Feb 11, 2026

View reviewed changes

Comment thread github/resource_github_repository_file.go

stevehipwell requested changes Feb 11, 2026

View reviewed changes

Comment thread website/docs/r/repository_file.html.markdown

fixup! Update docs with missing fields

e2cb7f4

Signed-off-by: Timo Sand <[email protected]>

stevehipwell changed the title ~~[MAINT] Improve docs of github_repository_file~~ [MAINT] Fixup github_repository_file Feb 11, 2026

stevehipwell added this to the v6.11.1 Patch milestone Feb 11, 2026

deiga requested a review from stevehipwell February 11, 2026 18:15

stevehipwell approved these changes Feb 11, 2026

View reviewed changes

nickfloyd approved these changes Feb 11, 2026

View reviewed changes

stevehipwell merged commit 256cdd8 into integrations:main Feb 11, 2026
7 checks passed

deiga deleted the update-repository_file-import-docs branch February 11, 2026 18:50

Conversation

deiga commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

github-actions Bot commented Feb 9, 2026

Uh oh!

deiga commented Feb 9, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stevehipwell commented Feb 9, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

deiga commented Feb 10, 2026

Uh oh!

stevehipwell commented Feb 10, 2026

Uh oh!

deiga commented Feb 10, 2026

Uh oh!

stevehipwell commented Feb 10, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

deiga commented Feb 10, 2026

Uh oh!

stevehipwell commented Feb 10, 2026

Uh oh!

deiga commented Feb 10, 2026

Uh oh!

stevehipwell commented Feb 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

deiga commented Feb 11, 2026

Uh oh!

deiga commented Feb 11, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

deiga commented Feb 9, 2026 •

edited

Loading